pp108 : Parameter Properties Interface

Parameter Properties Interface

This topic describes the fields that you fill while adding a parameter (attribute) to a method.


These properties determine the behaviour of the attribute in the method to which it is being added.

Table 1. Parameter Properties

Property

Description

Name

The name of the parameter

Attribute

The attribute of the class that will be associated with the parameter. A value is provided to this attribute if method implementation value default:GetByAttributes or default:GetByAttributesRange is used.

Type

The data type of the parameter. The following data types are available for selection, depending upon your requirement.

  • Unsigned Byte (ui1) - A one-byte unsigned integer
  • Unsigned Short (ui2) - A two-byte unsigned integer
  • Unsigned Integer (ui4) - A four-byte unsigned integer
  • Unsigned Long (ui8) - An eight-byte unsigned integer
  • Short Integer (i2) - A two-byte short integer
  • Integer (i4) - A four-byte integer
  • Long Integer (i8) - An eight-byte long integer
  • Float (r4) - A floating point number with four-byte encoding
  • Double (r8) - A floating point number with double precision
  • Currency (cy) - A floating point number that represents 'currency' data types
  • Select one of the following data types to represent XML as an integer in Java:
    • NOM xml node (xml)
    • DOM Element
      Note: When either of the data types is used, the Java class ( Extension class ) for that WS-AppServer model is generated with the following code, facilitating addition of related custom logic to process XML data:
      public static org.w3c.dom.Element DOM(org.w3c.dom.Element Dom)
          {
              // TODO implement body
              return null;
          }
      To add custom logic to this Java code, you can use the getObjectData() API as shown in the following code snippet:
      /* Returns the BusObject Data as a DOM Element
      * @return Document DOM Element containing the BusObject data
      */
      public Element getObjectData() {
      	return m_objectState.getCurrentObjectDataElement();
      }
      

  • string - String
  • dateTime - A date with an optional time data
    Note: WS-AppServer always works with GMT/UTC date and time format. It is therefore recommended to follow the same format during application development. For example, in the soap method of implementation type "BsfJavaCall", the arguments of type "Date" must be handled appropriately.
  • Base64 encoded BLOB (bin.base64) - MIME-style Base64 encoded binary large object (BLOB)
  • boolean - A value of either 0 to represent 'false' or 1 to represent 'true'
  • BusObject - Any data of type 'BusObject'
  • <classtype> - Refers to an existing class in the same package or a different package that can be a data type